Skip to main content

Cancelling Authorization

Cancelling an authorization​

Use this endpoint to cancel an Automatic Pix authorization

Request​

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:identifier'

Headers​

NameDescription                            
x-delbank-api-keyRequired. API key

Body​

{
    "id": "RR123456782024042912345678901",
    "debtorDocument": "12345678000199",
    "cancelReason": 6
}

Response​

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"id":"RR0435879820240605njua7shf40o",
"cancelId":"IC0435879820240605bcdb1fhn43a",
"cancelDate":"2024-06-13T10:10:06.101Z"
}

Fetch cancelled authorization​

This endpoint will fetch a cancelled authorization

Request​

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:authorizationIdentifier/cancellations/:cancellationIdentifier'

Headers​

NameDescription                            
x-delbank-api-keyRequired. API key

Path Parameters:​

NameTypeDescription
authorizationIdentifierstringRequired. Authorization identifier
cancellationIdentifierstringRequired. Cancelation identifier

Response​

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"id":"RR0435879820240605njua7shf40o",
"cancelId":"IC0435879820240605bcdb1fhn43a",
"debtorDocument":77379362038,
"cancelReason":6,
"cancelDate":"2024-09-17T10:10:06.101Z",
"cancelStatus":0
}